

======================
  GEANY HPL2 SUPPORT
      Release  1
      2012-10-28
======================





DESCRIPTION
===========


This archive contains Geany 1.22 support for the HPL2 engine (that runs Amnesia - The Dark Descent). More specifically, it supports AngelScript (.as/.hps), HPL2 language (.lang) files, and HPL2 configuration (.cfg) files.
Besides making things look prettier, it also helps you with typos (although you still have to check the casing yourself) and includes custom tags that don't interfere with C programming.

This archive also contains my custom color scheme, called MyCthulhu. It's primarily taylored for the HPL2 engine, but also has some Javascript support thrown in. It used to be the main feature of this pack, but installing it has now become completely optional. (Maybe you're *happy* with the circus of bright colors and the red operators - what do I know?)
The theme is dark based. Blue-ish text means system keywords, green-ish text means user details (like numbers and strings) and red-ish text means warnings or errors. If you have to squint to see the colors, then tough nuts. Eat more carrots.





AUTHOR
======


Cranky Old Man
(Yes, you can technically message me in the Frictional Games forums, but (due to there not being enough hours in a day) I'm not an active user there anymore, so consider yourself lucky if I eventually read your messages, ever.)

Tags and some development support by YourComputer.
(Yes, you can technically message him (if he's still around) but he has no way of messaging me either.)





DISTRIBUTION
============

You may distribute this archive for free, but you can also give me lots of money if you want. I'm just happy that people don't have to struggle with syntax and typos as much (and won't post such errors in the forums). I am aware that this will eventually lead to more cheap jumpscare stories being released by PDP fans, but what can you do?

I'm sure that anybody who uses AngelScript for anything else than gaming, will be happy to learn that there's Geany support for it now.

If you have suggestions for useful modifications to this pack, or you have made useful modifications yourself, send me a message (that I may or may not read - see above). Ultimately, you're free to release better versions of this pack.





CONTENTS
========


This archive should contain the following files:


filetype_extensions.conf   - Updated version. Defines which file extensions the new files have, and what filetype category to list them under.

filetypes.AngelScript.conf - Contains the configuration for AngelScript files.
filetypes.HPL2Config.conf  - Contains the configuration for HPL2 configuration files.
filetypes.Language.conf    - Contains the configuration for HPL2 Language files.

hpl2.hps.tags              - Contains HP script function tags.

mycthulhu.conf             - The custom colorscheme My Cthulhu.

Release Notes.txt          - This document file.





INSTALLATION INSTRUCTIONS
=========================


1. If you've not already done so before reading, extract this archive to some suitable place on your drive.



2. Locate your geany\ user folder.

Where this folder is located, depends on your operating system:
- In Windows 7, this folder should be located in "C:\Users\YourUserName\AppData\Roaming\".
- For other Windows versions, consult the manual for Geany.
- On Unix-like systems, this folder should be located in "~/.config/".

This folder should contain the filedefs\ and tags\ subfolders, that will later be referred to.
If the filedefs folder doesn't exist, you will need to create it.



3. Install the language custom filetypes.

Install the configurations for the three new languages (AngelScript, Language and HPL2Config), by moving all the files named "filetypes.*.conf" into the filedefs\ folder.

Define which file extensions are for these languages, and what filetype category to list them under, by updating Geany's "filetype_extensions.conf" file (located in the "Geany\data\" folder).
(You cannot use the filedefs\ folder for this.)
If you've never customized this file before, just move the already updated "filetype_extensions.conf" to the data\ folder, and choose to overwrite the old file with it.
If your "filetype_extensions.conf" has already been customized, you need to insert the necessary edits manually instead (by using the updated file as a guide).



4. SKIP THIS STEP - Remove the C function tags.

Before I made the AngelScript file type, Geany HLP2 scripting used to be done using the C language, which meant that you would want to remove the C (ISO/IEC 9899:1999 version) function tags (located in the "c99.tags" file, in the "data\" subfolder). This step is no longer necessary, which means that you can program C alongside with HPL2 now.



5.  Install the HPL2 function tags

Add the function tags, by moving the "hpl2.hps.tags" file into the tags\ folder. (Note that this is just the new name for the "hps.c.tags" file.)
In case there are ever new functions added (like with the release of "A Machine For Pigs") they can be copy-pasted from this address: http://pastebin.com/rcPQaWJt

(You have to restart Geany for the new user tags to take effect.)

I might add .lang tags in some later release, but don't count on it.



6. Optional - Install the My Cthulhu colorscheme.

Install the theme, by moving the "mycthulhu.conf" file into the "Geany\data\colorschemes\" folder.

Activate the scheme, by selecting View -> Editor -> Color Schemes in the Geany menus, and then selecting "My Cthulhu" from the list.




